home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-1.iso / program / swmp141.zip / PAS.DOC < prev    next >
Text File  |  1995-12-12  |  7KB  |  151 lines
  1.  
  2.  ┌────────────────────────────────────────────────────────────────────────────┐
  3.  │ Module Player V1.41     (c) 1994,1995 by Lord Excess of Sound Wizards Int. │
  4.  └────────────────────────────────────────────────────────────────────────────┘
  5.  
  6.  
  7.  
  8.         USING THE SWMP DRIVERS WITH 'TURBO PASCAL 7.0' (and below)
  9.         ──────────────────────────────────────────────────────────
  10.  
  11.          First of all you have to unzip the files of the included
  12.         archive PAS_SDK.ZIP to a location where the pascal compiler can
  13.         find them. This is either the directory where you keep your
  14.         source code or even better the Turbo Pascal directory itself.
  15.         The files you need in any case are:
  16.  
  17.               MODPLAY.PAS           : main unit
  18.               DETECT.PAS            : hardware detection unit
  19.               SB_DRV.PAS            : SoundBlaster unit
  20.               SBP_DRV.PAS           : SoundBlaster Pro unit
  21.               GUS_DRV.PAS           : Gravis UltraSound unit
  22.               DET_OBJ.OBJ           : detection code
  23.               SB_DRV.OBJ            : SB driver
  24.               SBP_DRV.OBJ           : SB Pro driver
  25.               GUS_DRV.OBJ           : GUS driver
  26.  
  27.          The rest are example files, which can be important to
  28.         understand things better. Now the only step to link all
  29.         mod-procedures and functions is to add the following statements
  30.         after your program heading:
  31.  
  32.               PROGRAM xxxxx;
  33.               {$M $4000,0,0}        : This sets the heap size to zero
  34.                                     : else the drivers cannot alloc memory
  35.               USES ModPlay;         : include unit ModPlay
  36.               ...
  37.               ..
  38.  
  39.          At program start you have to initialize this unit using the
  40.         following procedure:
  41.  
  42. ┌──INIT DRIVER─────────────────────────────────────────────────────────────────
  43. │       PROCEDURE Mod_Init(Driver,Port: WORD; IRQ,DMA: BYTE);
  44. │         -> Select and initialize driver for sound output
  45. │
  46. │            Driver = Detection         (0) :  Port = 0
  47. │                                              IRQ  = 0
  48. │                                              DMA  = 0
  49. │
  50. │                   = SoundBlaster      (1) :  Port = SB base address ($220..)
  51. │                                              IRQ  = SB IRQ#
  52. │                                              DMA  = 1 (always)
  53. │
  54. │                   = SoundBlaster_Pro  (2) :  Port = SBP base address
  55. │                                              IRQ  = SBP IRQ#
  56. │                                              DMA  = SBP DMA channel
  57. │
  58. │                   = Gravis_UltraSound (3) :  Port = GUS base address
  59. │                                              IRQ  = GF1 IRQ#
  60. │                                              DMA  = MIDI IRQ# !!
  61. └
  62.  
  63.  
  64.          A very powerful hardware detection is able to detect any
  65.         supported soundcard with all required settings. So in general
  66.         the easiest way to init the drivers is:
  67.  
  68.                 MOD_Init(Detection,0,0,0);
  69.  
  70.          If all fails you can override detection and select one of the
  71.         drivers by yourself, but in this case you have to know (or ask
  72.         for) the settings of an installed soundcard.
  73.  
  74.          If you want to know if initialisation was successfull, have a
  75.         look at the variable Soundcard (WORD), which will contain the
  76.         output device:
  77.  
  78.               0:        no sound available
  79.               1:        SoundBlaster            [ 22.2 kHz mono     ]
  80.               2:        SoundBlaster Pro        [ 21.7 kHz stereo   ]
  81.               3:        Gravis UltraSound       [ 44.1 kHz +stereo+ ]
  82.  
  83.          You do not have to handle this variable. You can also call the
  84.         driver's subfunctions even if no soundcard was detected,
  85.         nothing will happen in this case.
  86.  
  87.          At program end the unit selfrestores any altered interrupt
  88.         vectors etc.
  89.  
  90.          The following functions & procedures are available:
  91.         (Note: The first two procedures are enough to playback a mod !!!)
  92.  
  93. ┌──LOAD MODULE─────────────────────────────────────────────────────────────────
  94. │       PROCEDURE Mod_Load(FileName: STRING);
  95. │         -> Stops possible sound output, loads module file into memory,
  96. │            but does no start playing. If successful the variable
  97. │            Channels (WORD) will contain the number of channels, else zero.
  98. └
  99. ┌──PLAY MODULE─────────────────────────────────────────────────────────────────
  100. │       PROCEDURE Mod_Play(Looping: WORD);
  101. │         -> Starts playing previously loaded song. If looping is zero,
  102. │            song is played only once, else continuously.
  103. └
  104. ┌──STOP MODULE─────────────────────────────────────────────────────────────────
  105. │       PROCEDURE Mod_Stop;
  106. │         -> Stops sound output at once.
  107. └
  108. ┌──MAIN VOLUME─────────────────────────────────────────────────────────────────
  109. │       PROCEDURE Mod_Volume(Volume: BYTE);
  110. │         -> Changes the driver's main volume setting. Valid values are
  111. │            between 0 (lowest) and 64 (loudest).
  112. └
  113. ┌──STATUS──────────────────────────────────────────────────────────────────────
  114. │       FUNCTION Mod_Status: WORD;
  115. │         -> Returns 1 if sound is being played, else 0.
  116. └
  117. ┌──GET POSITION────────────────────────────────────────────────────────────────
  118. │       FUNCTION Mod_Position: WORD;
  119. │         -> Returns 256*PatternNumber+LineNumber. Can be useful to
  120. │            syncronize a special graphic effect to the sound.
  121. └
  122. ┌──JUMP BACK───────────────────────────────────────────────────────────────────
  123. │       PROCEDURE Mod_Rewind;
  124. │         -> Decreases current songposition. No effect in first pattern.
  125. └
  126.  
  127. ┌──JUMP FORWARD────────────────────────────────────────────────────────────────
  128. │       PROCEDURE Mod_Forward;
  129. │         -> Increases current songposition. No effect in last pattern.
  130. └
  131. ┌──PEAKS───────────────────────────────────────────────────────────────────────
  132. │       PROCEDURE Mod_Peak(VAR Peaks);
  133. │         -> Updates the array Peaks by copying the driver's volume
  134. │            setting (0..64) of each channel. The number of channels
  135. │            can be found in the variable Channels (WORD) and is either
  136. │            four, six or eight.
  137. └
  138.  
  139.  
  140.          In general it remains to be said that you can do as much error
  141.         checking as you like, but it is not necessary. In a demo or
  142.         intro for example you do not care if there is sound available
  143.         to the grafix you produce on the screen (in most cases). But in
  144.         a player it is evident that you need to have any sounddevice at
  145.         all to output the sound! The best way is to take a look at the
  146.         example programs. Have a lot of fun!
  147.  
  148.  
  149.                                                Lord Excess in Dezember '95
  150. 
  151.